home *** CD-ROM | disk | FTP | other *** search
/ CD Exchange / CD Exchange - Volume 1.iso / education / amiflash / amiflash.readme < prev    next >
Text File  |  1993-04-09  |  13KB  |  292 lines
  1. **********************************************************************
  2. *                                                                    *
  3. *   AmiFlash       version 1.0.0          Release Date: 04/03/93     *
  4. *   Copyright ©1993 Michael Neylon and Bill Gundlach                 *
  5. *   All rights reserved                                              *
  6. *                                                                    *
  7. *   Fully-functional 'demo' version of a fast and flexible           *
  8. *   flashcard-type study program. (requires WB 2.0)                  *
  9. *                                                                    *
  10. **********************************************************************
  11.  
  12. 0. Reqtools Copyright
  13.  
  14. Reqtools.Library is Copyright © Nico Francois.  As per his documentation,
  15. the 2.0 version of the library is the only file from that archive that
  16. is distributed in this package.
  17.  
  18. 1. What is AmiFlash?
  19.  
  20. Simply, AmiFlash is a program to help you memorize information.
  21. Remember when you were in school and you memorized your vocabulary
  22. words by writing them on index cards?  AmiFlash can 'ask' you questions,
  23. repeat the words that you missed, and also keep track of your score.
  24.  
  25. 2.  What do I need to run AmiFlash?
  26.  
  27. AmiFlash was written to work on an Amiga computer system that has
  28. Workbench 2.0 or above.  To use the program, you decompress the
  29. files in the archive and click on the Install icon.  This will copy
  30. the reqtools library to your libs: drawer.  In order for AmiFlash to
  31. work, it is necessary that the reqtools.library be in libs:.
  32. Overall, both the AmiFlash program and the editor take about 40K
  33. of free memory apiece plus the amount of data stored in the
  34. current 'deck' of cards.
  35.  
  36. AmiFlash has been tested on all models of the Amiga computer
  37. under 2.0x and 2.1/3.0.  No errors have been reported by
  38. Enforcer when run on a MMU machine (according to the beta
  39. testers).
  40.  
  41. 3. Starting the Program
  42.  
  43. You can start AmiFlash by either clicking on its icon or running
  44. it from the command line.  The command line invocation is:
  45.  
  46.    AmiFlash [options] [<filename>]
  47.  
  48. Where [options] are in the following format:
  49.    [options] = [STRAIGHT|RANDOM] [ONCE|STUDY] [KEYPRESS|TIMEOUT]
  50.                [DELAY=<n>]
  51.  
  52. and the follow template:
  53.  
  54.    STRAIGHT/K, RANDOM/K, ONCE/K, STUDY/K, TIMEOUT/K, KEYPRESS/K,
  55.       DELAY/K/N
  56.  
  57. The options STRAIGHT, ONCE, and KEYPRESS are on by default.  The
  58. default DELAY is 3 seconds.  You may call AmiFlash with the
  59. infamous '?' option to remind yourself of the commands.  Note that
  60. this does not behave the same as with most AmigaDOS commands YET.
  61.  
  62. Similarly, there 4 ToolTypes that are in the .info file. These are:
  63.  
  64.    ORDER = STRAIGHT|RANDOM            (off by default)
  65.    MODE = ONCE|STUDY                  (once by default)
  66.    WAITTYPE = KEYPRESS|TIMEOUT        (key is default)
  67.    DELAY = ##
  68.  
  69. Futhermore, you may start AmiFlash from the workbench by using the
  70. multiple select and double-clicking on AmiFlash or setting a
  71. datadeck's ToolType to AmiFlash.
  72.  
  73. 4. Using the program
  74.  
  75. Overall, using AmiFlash is very straightforward (almost not worth
  76. reading the manual 8^)).  Once you start the program, it will ask
  77. you to load the deck (if necessary) and then wait for you to begin.
  78. The menu is very straight-forward. (I hope!)
  79.  
  80. AmiFlash has been programmed with GadToolsBox using the Adapt.Font/
  81. System.font option.  Thus, it will attempt to open the window using your
  82. system font for the gadget text, but if it is too big, it will default to
  83. topaz 8.  On a non-interlaced, NTSC screen, this allows a maximum point
  84. size of 12.  Thus, for you interlaced folk, you should have no problem
  85. seeing the text :)
  86.  
  87. There are two types of testing modes currently available in AmiFlash.
  88. The first method is a 'once-thru' mode.  This allows you to study the
  89. cards in the deck, being tested on each one only once.  For those that
  90. are more pesistent, a 'study' mode is available.  This allows you
  91. to go through the deck, but put cards back in stack if you don't
  92. get the right answer.
  93.  
  94. Just so you don't get bored seeing the same cards every time
  95. you run the program, we've included a randomizer that will
  96. 'shuffle' cards in the deck.  Of course, if you don't use this option,
  97. you'll see the cards in the order in wwhich they were entered.
  98.  
  99. Finally, there is an option which determines how AmiFlash will
  100. wait after you have entered your answer to a question.  The
  101. default will wait for you to press a key to go to the next card.
  102. As of v0.9.6, only the <return> and <space> keys will perform this
  103. actions.  The gadgets shortcuts will perform their actions as well.
  104. If you don't want to do this, you can set AmiFlash to wait
  105. for a number of seconds (1-15) before going on to the next card.
  106. Right now, only one wait method can be used.  If you use the timer,
  107. pressing a key will now (starting with version 0.9.2!) send you to
  108. the next card, however, intuition functions are currently disabled
  109. during this brief time.
  110.  
  111. You may quit or load a new deck while using a deck without a problem.
  112. If you answer all the cards in one deck, you will be presented
  113. with a small requestor with very simple statistics.
  114.  
  115. 5.  Important note about AmiFlash
  116.  
  117. This version of AmiFlash is what is commonly referred to as
  118. "cripple-ware."  The program will only use the first 15 cards
  119. out of every deck.  Yes, Mike and I know that this is annoying,
  120. but this is necessary to get people to register.  We're asking
  121. for a very small amount of money for our programming efforts.
  122. The suggested donation is $5.00 US.  If you use AmiFlash and
  123. like it, we ask that you send us the registration fee.  In turn,
  124. Mike and I will send you a full registered copy of AmiFlash, in
  125. which the decksize is only limited by the amount of free RAM.
  126. Registered users will receive free updates to AmiFlash.
  127. See Section 7 for the new features to be added to the newest
  128. registered version of AmiFlash (we're already working on a
  129. number of them - HINT HINT).
  130.  
  131. 6.  Contacting the Authors
  132.  
  133. The majority of the included programs were coded by Mike Neylon.
  134. Bill Gundlach helped out and wrote the wonderful documentation that
  135. you're reading now. Yay!  Mike and I can both be contacted by e-mail
  136. through Internet.  In fact, we prefer this method of communication.
  137.  
  138. Mike Neylon - mneylon@jupiter.cse.utoledo.edu
  139. Bill Gundlach - bgundlac@jupiter.cse.utoledo.edu
  140.  
  141. These addresses should be valid any time during the normal school
  142. year.  Mine should also be valid for the 93-94 school year.  I don't
  143. know if Mike's will.  (Mike sez: I will try to release my summer email
  144. address as soon as possible.  To be safe, you can probably get me at the
  145. above address.)
  146.  
  147. During school, our Snail-mail address is:
  148.  
  149.    Bill Gundlach
  150.    #117 White Hall
  151.    2061 Campus  Dr.
  152.    Toledo, OH 43606
  153.  
  154. During the summer, use:
  155.  
  156.    Bill Gundlach
  157.    1611 Cedar Point Rd
  158.    Sandusky, OH 44870-5210
  159.  
  160. Mike and I welcome suggestions and bug reports concerning AmiFlash.
  161. Actually, we don't mind complements, either. :-)
  162.  
  163. 7.  Features planned for future versions
  164.  
  165. - Multiple right answers for questions
  166. - More quiz modes
  167. - Multiple line questions
  168. - User-definable categories for words and quizzes by category
  169. - Enhanced reporting features
  170. - Decks that 'remember' what you missed last time
  171.  
  172. 8. History of the Program
  173.  
  174. AmiFlash started as a project that I (Bill) started to try and
  175. learn C.  Many crashed program later, I brought the idea to Mike.
  176. He helped me code the mechanics of the program and skillfully
  177. wrote the entire user interface.
  178.  
  179. ---------------------------------------------------------------------------
  180. Version    MM/DD/YY
  181.  
  182. 0.9.0b     03/07/93     First release to beta testers
  183.  
  184. 0.9.1      03/08/93   - Changed Version numbers to strings (giving a bit
  185.                         more freedom with these.)
  186.                       - Fixed 'About' requester problem with Version
  187.                         numbers (gave nonsense before)
  188.                       - If user enters a delay time <0 or >15 secs (while
  189.                         in the program), a requester is brought up telling
  190.                         him of the error, and the delay is reset to 5sec.
  191.                       - A VersionString is now impletemented, so it works
  192.